-
Notifications
You must be signed in to change notification settings - Fork 188
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: Rewrite and restructure the documentation website #933
Conversation
✅ Deploy Preview for creative-fairy-df92c4 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
docs/public/_redirects
Outdated
# https://github.com/wxt-dev/wxt/issues/704 | ||
# Generated via `find docs/.vitepress/dist -type f -name "*.html"` | ||
/guide/i18n/build-integrations.html /TODO | ||
/guide/i18n/introduction.html /TODO | ||
/guide/i18n/messages-file-format.html /TODO | ||
/guide/i18n/editor-support.html /TODO | ||
/guide/i18n/installation.html /TODO | ||
/guide/key-concepts/content-script-ui.html /TODO | ||
/guide/key-concepts/manifest.html /TODO | ||
/guide/key-concepts/wxt-submit.html /TODO | ||
/guide/key-concepts/auto-imports.html /TODO | ||
/guide/key-concepts/web-extension-polyfill.html /TODO | ||
/guide/key-concepts/frontend-frameworks.html /TODO | ||
/guide/key-concepts/multiple-browsers.html /TODO | ||
/guide/go-further/entrypoint-loaders.html /TODO | ||
/guide/go-further/es-modules.html /TODO | ||
/guide/go-further/handling-updates.html /TODO | ||
/guide/go-further/custom-events.html /TODO | ||
/guide/go-further/debugging.html /TODO | ||
/guide/go-further/remote-code.html /TODO | ||
/guide/go-further/vite.html /TODO | ||
/guide/go-further/testing.html /TODO | ||
/guide/go-further/how-wxt-works.html /TODO | ||
/guide/go-further/reusable-modules.html /TODO | ||
/guide/extension-apis/messaging.html /TODO | ||
/guide/extension-apis/i18n.html /TODO | ||
/guide/extension-apis/storage.html /TODO | ||
/guide/extension-apis/scripting.html /TODO | ||
/guide/extension-apis/others.html /TODO | ||
/guide/upgrade-guide/wxt.html /TODO | ||
/guide/directory-structure/components.html /TODO | ||
/guide/directory-structure/hooks.html /TODO | ||
/guide/directory-structure/assets.html /TODO | ||
/guide/directory-structure/package.html /TODO | ||
/guide/directory-structure/env.html /TODO | ||
/guide/directory-structure/wxt-config.html /TODO | ||
/guide/directory-structure/wxt.html /TODO | ||
/guide/directory-structure/public/locales.html /TODO | ||
/guide/directory-structure/public/index.html /TODO | ||
/guide/directory-structure/entrypoints/devtools.html /TODO | ||
/guide/directory-structure/entrypoints/sidepanel.html /TODO | ||
/guide/directory-structure/entrypoints/content-scripts.html /TODO | ||
/guide/directory-structure/entrypoints/newtab.html /TODO | ||
/guide/directory-structure/entrypoints/bookmarks.html /TODO | ||
/guide/directory-structure/entrypoints/unlisted-pages.html /TODO | ||
/guide/directory-structure/entrypoints/unlisted-scripts.html /TODO | ||
/guide/directory-structure/entrypoints/options.html /TODO | ||
/guide/directory-structure/entrypoints/background.html /TODO | ||
/guide/directory-structure/entrypoints/popup.html /TODO | ||
/guide/directory-structure/entrypoints/history.html /TODO | ||
/guide/directory-structure/entrypoints/sandbox.html /TODO | ||
/guide/directory-structure/entrypoints/css.html /TODO | ||
/guide/directory-structure/web-ext-config.html /TODO | ||
/guide/directory-structure/tsconfig.html /TODO | ||
/guide/directory-structure/utils.html /TODO | ||
/guide/directory-structure/app-config.html /TODO | ||
/guide/directory-structure/composables.html /TODO | ||
/guide/directory-structure/output.html /TODO | ||
/get-started/assets.html /TODO | ||
/get-started/introduction.html /TODO | ||
/get-started/configuration.html /TODO | ||
/get-started/publishing.html /TODO | ||
/get-started/migrate-to-wxt.html /TODO | ||
/get-started/compare.html /TODO | ||
/get-started/entrypoints.html /TODO | ||
/get-started/installation.html /TODO |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
TODO
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #933 +/- ##
==========================================
+ Coverage 82.04% 82.21% +0.16%
==========================================
Files 127 127
Lines 6634 6634
Branches 1103 1105 +2
==========================================
+ Hits 5443 5454 +11
+ Misses 1177 1166 -11
Partials 14 14 ☔ View full report in Codecov by Sentry. |
19ca63e
to
3cb2f5f
Compare
da81816
to
2b94887
Compare
@wxt-dev/i18n
@wxt-dev/auto-icons
@wxt-dev/module-react
@wxt-dev/module-solid
@wxt-dev/module-svelte
@wxt-dev/module-vue
wxt
commit: |
Do you want us to put specific comments on the wording of things in the new docs here? For example on this page this phrase is tripping me up:
That doesn't mean WTX creates them, though? WTX uses them to build the final files, right? Maybe I'm just not familiar with the proper terminology. |
Yup, that's fine! |
I see how it could be read that way... Let's update it! What about this?
|
Perfect! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Small misspelling here
Should be "caveat" I think. I mean, it should be spelled the way you wrote, but unfortunately it isn't, 😅 |
@placoderm Fixed
@Timeraa fixed
@placoderm fixed I'm using Zed, which doesn't have a spellcheck plugin yet, so there's probably a lot of these lol... |
Sent all the files through AI, and it found lots of typos. They should all be fixed now. |
https://deploy-preview-933--creative-fairy-df92c4.netlify.app/guide/resources/migrate.html |
I'm not sure the level of knowledge you are expecting from the folks reading the docs. For example in the vite plugin instructions It wasn't clear to me that at the top of my wxt.config.ts file I needed to import the plugin. It also wasn't clear that instead of just putting the name of the plugin, this is where all the arguments for the function went. Instead of:
Perhaps it could say:
Personally I would have appreciated an example like this:
Again, I don't know what level of user you are targeting. |
9bb305b
to
cd65fe1
Compare
I expect people to read Vite's docs if they want to learn more about Vite's features. On that page, I felt my only requirements were to show people how to add vite config and mention that they can use Vite plugins. I do think adding a plugin as an example is a good idea. I got a bit lazy there. |
If there is anything you can be accused of it is certainly not being lazy, lol. You have done a huge service to your community of users. After I posted the above snippet I realize that it was working, but not the way I intended. I wanted to see the vite: (configEnv) => ({
plugins: [configEnv.mode === "production" && removeConsole({ includes: ["log"] })],
}), |
That's a good example of the differences between vite plugins and how they're used in WXT. I'll add a different example for the basic setup, and add that one as an example for the behavior differences section. |
Alright, gonna get this merged today. Just need to update all the redirect links to make sure old links still work, then we're good to go! |
Thank you so much for doing all this. It's a great blessing. |
Alright, made a few final changes, gonna merge! Thanks everyone for your feedback :) I don't plan on doing another huge rewrite like this again... it sucked lol but I'm happy with how it's turned out! |
Thank you so much! It's clear you put a lot of time and care into it. First class work. |
This closes #704
TODOs:
webextension-polyfill
viaextensionApi: "chrome"
#868 (comment)